Fzzy Config/me.fzzyhmstrs.fzzy_config.validation.misc/ValidatedMapped

ValidatedMapped

open class ValidatedMapped<N, T> @JvmOverloads constructor(delegate: ValidatedField<T>, to: Function<T, out N>, from: Function<in N, T>, defaultValue: N = to.apply(delegate.get())) : ValidatedField<N>

Represents a ValidatedField mapped to another value representable by the wrapped delegate

Author

fzzyhmstrs

Since

0.5.0

Inheritors

ValidatedCondition

Constructors

ValidatedMapped

@JvmOverloads

constructor(delegate: ValidatedField<T>, to: Function<T, out N>, from: Function<in N, T>, defaultValue: N = to.apply(delegate.get()))

Functions

open override fun accept(input: N)

updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet

addListener

open override fun addListener(listener: Consumer<ValidatedField<N>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

andThen

open fun andThen(p0: Consumer<in N>): Consumer<N>

codec

fun codec(): Codec<N>

Provides a Codec representing the value type of this validation, backed by the validators within as applicable

copyStoredValue

open fun copyStoredValue(): N

Copies the stored value and returns it.

correctEntry

open override fun correctEntry(input: N, type: EntryValidator.ValidationType): ValidationResult<N>

description

open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

descriptionKey

open override fun descriptionKey(): String

translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

deserialize

open override fun deserialize(toml: TomlElement, fieldName: String): ValidationResult<N>

deserializes the fields stored value from TomlElement. This should not set the fields stored value, or interact with the field at all except to get the stored value for error reporting. deserializeEntry handles that.

get

open override fun get(): N

Gets the wrapped result value from the mapped delegate

getDefault

fun getDefault(): N

Provides this validations default value

hasDescription

open fun hasDescription(): Boolean

Whether this Translatable has a valid description

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

instanceEntry

open override fun instanceEntry(): ValidatedField<N>

isValidEntry

open override fun isValidEntry(input: Any?): Boolean

map

fun <N> map(to: Function<N, out N>, from: Function<in N, N>): ValidatedField<N>

Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue

fun <N> map(defaultValue: N, to: Function<N, out N>, from: Function<in N, N>): ValidatedField<N>

fun <N> map(to: Function<N, out N>, from: Function<in N, N>, defaultValue: N): ValidatedField<N>

Maps this validation to a new convertible type.

serialize

open override fun serialize(input: N): ValidationResult<TomlElement>

Serializes the provided input to a TomlElement

toCondition

open fun toCondition(condition: ValidatedField<Boolean>, fallback: Supplier<N>): ValidatedCondition<N>

Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(condition: ValidatedCondition.Condition, fallback: Supplier<N>): ValidatedCondition<N>

open fun toCondition(condition: Supplier<Boolean>, failMessage: Text, fallback: Supplier<N>): ValidatedCondition<N>

Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(scope: String, failMessage: Text, fallback: Supplier<N>): ValidatedCondition<N>

Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.

toList

fun toList(vararg elements: N): ValidatedList<N>

wraps the provided values into a ValidatedList with this field as validation

fun toList(collection: Collection<N>): ValidatedList<N>

wraps the provided collection into a ValidatedList with this field as validation

toSet

fun toSet(vararg elements: N): ValidatedSet<N>

wraps the provided values into a ValidatedSet with this field as validation

fun toSet(collection: Collection<N>): ValidatedList<N>

wraps the provided collection into a ValidatedList with this field as validation

translation

open override fun translation(fallback: String?): MutableText

The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)

translationKey

open override fun translationKey(): String

translation key of this Translatable. the "name" in-game

trySerialize

fun trySerialize(input: Any?, errorBuilder: MutableList<String>, flags: Byte): TomlElement?

trySet

open override fun trySet(input: Any?)

update

open fun update(updateMessage: Text)

validateAndSet

open fun validateAndSet(input: N): ValidationResult<N>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

validateEntry

open override fun validateEntry(input: N, type: EntryValidator.ValidationType): ValidationResult<N>

widgetAndTooltipEntry

open fun widgetAndTooltipEntry(choicePredicate: ChoiceValidator<N> = ChoiceValidator.any()): ClickableWidget

widgetEntry

open override fun widgetEntry(choicePredicate: ChoiceValidator<N>): ClickableWidget